script.js ➔ olInit - Code Metrics - Inspection of "Openlayers 6" - mprins/dokuwiki-plugin-openlayersmap - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#10)

by Mark

created 2022-06-08 19:54 UTC

script.js ➔ olInit B

↳ Parent: ol6/script.js

Complexity

Conditions

Size

Total Lines	58
Code Lines	36

Duplication

Lines	31
Ratio	53.45 %

Importance

Changes

Metric	Value
eloc	36
c	0
b	0
f	0
dl	31
loc	58
rs	7.1493
cc	8

How to fix Long Method

/*
 * Copyright (c) 2022 Mark C. Prins <[email protected]>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */



/**
 * Test for css support in the browser by sniffing for a css class we added
 * using javascript added by the action plugin; this is an edge case because
 * browsers that support javascript generally support css as well.
 *
 * @returns {Boolean} true when the browser supports css (and implicitly
 *          javascript)
 */
function olTestCSSsupport() {
    return (jQuery('.olCSSsupported').length > 0);
}

/**
 * Creates a DocumentFragment to insert into the dom.
 *
 * @param mapid
 *            id for the map div
 * @param width
 *            width for the map div
 * @param height
 *            height for the map div
 * @returns a {DocumentFragment} element that can be injected into the dom
 */
function olCreateMaptag(mapid, width, height) {
    const mEl = '<div id="' + mapid + '-olContainer" class="olContainer olWebOnly">'
            // map
            + '<div id="' + mapid + '" tabindex="0" style="width:' + width + ';height:' + height + ';" class="olMap"></div>'
            + '</div>',
        // fragment
        frag = document.createDocumentFragment(),
        // temp node
        temp = document.createElement('div');
    temp.innerHTML = mEl;
    while (temp.firstChild) {
        frag.appendChild(temp.firstChild);
    }
    return frag;
}

/**
 * Create the map based on the params given.
 *
 * @param {Object}
 *            mapOpts MapOptions hash {id:'olmap', width:500px, height:500px,
 *            lat:6710200, lon:506500, zoom:13, statusbar:1, controls:1,
 *            poihoverstyle:1, baselyr:'', kmlfile:'', gpxfile:'', geojsonfile,
 *            summary:''}
 * @param {Array}
 *            OLmapPOI array with POI's [ {lat:6710300,lon:506000,txt:'instap
 *            punt',angle:180,opacity:.9,img:'', rowId:n},... ]);
 *
 * @return {OpenLayers.Map} the created map
 */
function createMap(mapOpts, poi) {

    // const mapOpts = olMapData[0].mapOpts;
    // const poi = olMapData[0].poi;

    if (!olEnable) {

        return;

    }
    if (!olTestCSSsupport()) {
        olEnable = false;

        return;

    }

    // find map element location
    var cleartag = document.getElementById(mapOpts.id + '-clearer');
    if (cleartag === null) {
        return;

    }
    // create map element and add to document
    var fragment = olCreateMaptag(mapOpts.id, mapOpts.width, mapOpts.height);
    cleartag.parentNode.insertBefore(fragment, cleartag);



const overlayGroup = new ol.layer.Group({title: 'Overlays', fold: 'open', layers: []});

const baseLyrGroup = new ol.layer.Group({'title': 'Base maps', layers: []});

const map = new ol.Map({
    target: document.getElementById('map'),
    layers: [baseLyrGroup, overlayGroup],
    view:   new ol.View({
        center:     ol.proj.transform([mapOpts.lon, mapOpts.lat], 'EPSG:4326', 'EPSG:3857'),
        zoom:       mapOpts.zoom,
        projection: 'EPSG:3857'
    })
});

let /**
 * Thunderforest API key.
 *
 * @type {String}
 */
tfApiKey = '';
let /**
 * OSM tiles flag.
 *
 * @type {Boolean}
 */
osmEnable = true;
if (osmEnable) {

    baseLyrGroup.getLayers().push(
        new ol.layer.Tile({
            visible: true,
            title:   'OSM',
            type:    'base',
            source:  new ol.source.OSM()
        }));

    baseLyrGroup.getLayers().push(
        new ol.layer.Tile({
            visible: mapOpts.baselyr === "cycle map",
            title:   'cycle map',
            type:    'base',
            source:  new ol.source.OSM({
                url:          'https://{a-c}.tile.thunderforest.com/cycle/{z}/{x}/{y}.png?apikey=' + tfApiKey,
                attributions: 'Data &copy;ODbL <a href="https://openstreetmap.org/copyright" target="_blank">OpenStreetMap</a>, '
                                  + 'Tiles &copy;<a href="https://www.thunderforest.com/" target="_blank">Thunderforest</a>'
                                  + '<img src="https://www.thunderforest.com/favicon.ico" alt="Thunderforest logo"/>'
            })
        }));

    baseLyrGroup.getLayers().push(
        new ol.layer.Tile({
            visible: mapOpts.baselyr === "transport",
            title:   'transport',
            type:    'base',
            source:  new ol.source.OSM({
                url:          'https://{a-c}.tile.thunderforest.com/transport/{z}/{x}/{y}.png?apikey=' + tfApiKey,
                attributions: 'Data &copy;ODbL <a href="https://openstreetmap.org/copyright" target="_blank">OpenStreetMap</a>, '
                                  + 'Tiles &copy;<a href="https://www.thunderforest.com/" target="_blank">Thunderforest</a>'
                                  + '<img src="https://www.thunderforest.com/favicon.ico" alt="Thunderforest logo"/>'
            })
        }));

    baseLyrGroup.getLayers().push(
        new ol.layer.Tile({
            visible: mapOpts.baselyr === "landscape",
            title:   'landscape',
            type:    'base',
            source:  new ol.source.OSM({
                url:          'https://{a-c}.tile.thunderforest.com/landscape/{z}/{x}/{y}.png?apikey=' + tfApiKey,
                attributions: 'Data &copy;ODbL <a href="https://openstreetmap.org/copyright" target="_blank">OpenStreetMap</a>, '
                                  + 'Tiles &copy;<a href="https://www.thunderforest.com/" target="_blank">Thunderforest</a>'
                                  + '<img src="https://www.thunderforest.com/favicon.ico" alt="Thunderforest logo"/>'
            })
        }));

    baseLyrGroup.getLayers().push(
        new ol.layer.Tile({
            visible: mapOpts.baselyr === "outdoors",
            title:   'outdoors',
            type:    'base',
            source:  new ol.source.OSM({
                url:          'https://{a-c}.tile.thunderforest.com/outdoors/{z}/{x}/{y}.png?apikey=' + tfApiKey,
                attributions: 'Data &copy;ODbL <a href="https://openstreetmap.org/copyright" target="_blank">OpenStreetMap</a>, '
                                  + 'Tiles &copy;<a href="https://www.thunderforest.com/" target="_blank">Thunderforest</a>'
                                  + '<img src="https://www.thunderforest.com/favicon.ico" alt="Thunderforest logo"/>'
            })
        }));
}

let /**
 * Bing tiles flag.
 *
 * @type {Boolean}
 */
bEnable = false;
let /**
 * Bing API key.
 *
 * @type {String}
 */
bApiKey = '';
if (bEnable && bApiKey !== '') {

    baseLyrGroup.getLayers().push(
        new ol.layer.Tile({
            visible: mapOpts.baselyr === "bing road",
            title:   'bing road',
            type:    'base',
            source:  new ol.source.BingMaps({
                key:        bApiKey,
                imagerySet: 'Road'
            })
        }));

    baseLyrGroup.getLayers().push(
        new ol.layer.Tile({
            visible: mapOpts.baselyr === "bing sat",
            title:   'bing sat',
            type:    'base',
            source:  new ol.source.BingMaps({
                key:        bApiKey,
                imagerySet: 'Aerial'
            })
        }));

    baseLyrGroup.getLayers().push(
        new ol.layer.Tile({
            visible: mapOpts.baselyr === "bing hybrid",
            title:   'bing hybrid',
            type:    'base',
            source:  new ol.source.BingMaps({
                key:        bApiKey,
                imagerySet: 'AerialWithLabels'
            })
        }));
}

let /**
 * Stamen tiles flag.
 *
 * @type {Boolean}
 */
stamenEnable = false;
if (stamenEnable) {
    baseLyrGroup.getLayers().push(
        new ol.layer.Tile({
            visible: false,
            type:    'base',
            title:   'toner',
            source:  new ol.source.Stamen({layer: 'toner'})
        })
    );
    baseLyrGroup.getLayers().push(
        new ol.layer.Tile({
            visible: false,
            type:    'base',
            title:   'terrain',
            source:  new ol.source.Stamen({layer: 'terrain'})
        })
    );
}

map.addControl(new ol.control.ScaleLine({bar: true, text: true}));
map.addControl(new ol.control.MousePosition({
    coordinateFormat: ol.coordinate.createStringXY(4), projection: 'EPSG:4326',
}));
map.addControl(new ol.control.FullScreen());
map.addControl(new ol.control.OverviewMap());
map.addControl(new ol.control.LayerSwitcher());

const iconScale = 1.5;
const vectorSource = new ol.source.Vector();
poi.forEach((p) => {

    const f = new ol.Feature({

        geometry:    new ol.geom.Point(ol.proj.fromLonLat([p.lon, p.lat])),
        description: p.txt,
        img:         p.img,
        rowId:       p.rowId,
        lat:         p.lat,
        lon:         p.lon,
        angle:       p.angle,
        alt:         p.img.substring(0, p.img.lastIndexOf("."))
    });
    f.setId(p.rowId);
    f.setStyle(new ol.style.Style({
        text:      new ol.style.Text({
            text:           "" + p.rowId,
            textAlign:      'left',
            textBaseline:   'bottom',
            offsetX:        8,
            offsetY:        -8,
            scale:          iconScale,
            fill:           new ol.style.Fill({color: 'rgb(0,0,0)'}),
            font:           '12px monospace bold',
            backgroundFill: new ol.style.Fill({color: 'rgba(255,255,255,.4)'})
        }), image: new ol.style.Icon({
            src: "./" + p.img, crossOrigin: '', opacity: p.opacity, scale: iconScale, rotation: p.angle * Math.PI / 180,
        }),
    }));
    vectorSource.addFeature(f);
});

overlayGroup.getLayers().push(new ol.layer.Vector({title: 'POI', visible: true, source: vectorSource}));

if (mapOpts.kmlfile.length > 0) {
    overlayGroup.getLayers().push(new ol.layer.Vector({
        title:  'KML file', visible: true,
        source: new ol.source.VectorSource({
            url:    mapOpts.kmlfile,
            format: new ol.format.KML(),
        }),
        style:  {label: "${name}"}
    }));
}

if (mapOpts.geojsonfile.length > 0) {
    overlayGroup.getLayers().push(new ol.layer.Vector({
        title:  'GeoJSON file', visible: true,
        source: new ol.source.VectorSource({
            url:    mapOpts.geojsonfile,
            format: new ol.format.GeoJSON(),
        }),
        style:  {
            /* TODO */
            strokeColor:   "#FF00FF",
            strokeWidth:   3,
            strokeOpacity: 0.7,
            pointRadius:   4,
            fillColor:     "#FF99FF",
            fillOpacity:   0.7
        }
    }));
}

if (mapOpts.gpxfile.length > 0) {
    overlayGroup.getLayers().push(new ol.layer.Vector({
        title:  'GPS track', visible: true,
        source: new ol.source.VectorSource({
            url:    mapOpts.gpxfile,
            format: new ol.format.GPX(),
        }),
        style:  {
            /* TODO */
            strokeColor:   "#0000FF",
            strokeWidth:   3,
            strokeOpacity: 0.7,
            pointRadius:   4,
            fillColor:     "#0099FF",
            fillOpacity:   0.7
        }
    }));
}

const container = document.getElementById('popup');
const content = document.getElementById('popup-content');
const closer = document.getElementById('popup-closer');

const overlay = new ol.Overlay({
    element: container, autoPan: true, autoPanAnimation: {
        duration: 250,
    }, //stopEvent: false,
});
map.addOverlay(overlay);

/**
 * Add a click handler to hide the popup.
 * @return {boolean} Don't follow the href.
 */
closer.onclick = function () {
    overlay.setPosition(undefined);
    closer.blur();
    return false;
};

// display popup on click
map.on('singleclick', function (evt) {

    const selFeature = map.forEachFeatureAtPixel(evt.pixel, function (feature) {
        return feature;
    });
    if (selFeature) {
        overlay.setPosition(evt.coordinate);

        let pContent = '<div class="spacer">&nbsp;</div>';
        let locDesc = '';

        if (selFeature.get('rowId') !== undefined) {
            pContent += '<span class="rowId">' + selFeature.get('rowId') + ': </span>';
        }
        if (selFeature.get('name') !== undefined) {
            pContent += '<span class="txt">' + selFeature.get('name') + '</span>';
            locDesc = selFeature.get('name');

            // TODO strip <p> tag from locDesc
            // locDesc = selFeature.get('name').split(/\s+/).slice(0,2).join('+');
        }
        if (selFeature.get('ele') !== undefined) {
            pContent += '<div class="ele">elevation: ' + selFeature.get('ele') + '</div>';
        }
        if (selFeature.get('type') !== undefined) {
            pContent += '<div>' + selFeature.get('type') + '</div>';
        }
        if (selFeature.get('time') !== undefined) {
            pContent += '<div class="time">time: ' + selFeature.get('time') + '</div>';
        }
        if (selFeature.get('description') !== undefined) {
            pContent += '<div class="desc">' + selFeature.get('description') + '</div>';
        }
        if (selFeature.get('img') !== undefined) {
            pContent += '<div class="coord" title="lat;lon">' + '<img src="' + selFeature.get('img') + '" width="16" height="16" ' + 'style="transform:rotate(' + selFeature.get('angle') + 'deg)" />&nbsp;' + '<a href="geo:' + selFeature.get('lat') + ',' + selFeature.get('lon') + '?q=' + selFeature.get('lat') + ',' + selFeature.get('lon') + '(' + selFeature.get('alt') + ')" title="Open in navigation app">' + ol.coordinate.format([selFeature.get('lon'), selFeature.get('lat')], '{x}º; {y}º', 4) + '</a></div>';

        }
        content.innerHTML = pContent;
    } else {

        // do nothing?...
    }
});

// change mouse cursor when over marker
map.on('pointermove', function (e) {
    const pixel = map.getEventPixel(e.originalEvent);
    const hit = map.hasFeatureAtPixel(pixel);
    map.getTarget().style.cursor = hit ? 'pointer' : '';
});

    return map;
}


/** init. */
function olInit() {
    if (olEnable) {





        var _i = 0;
        // create the maps in the page
        for (_i = 0; _i < olMapData.length; _i++) {

            var _id = olMapData[_i].mapOpts.id;
            olMaps[_id] = createMap(olMapData[_i].mapOpts, olMapData[_i].poi);


            // set max-width on help pop-over
            jQuery('#' + _id).parent().parent().find('.olMapHelp').css('max-width', olMapData[_i].mapOpts.width);

            // shrink the map width to fit inside page container
            const _w = jQuery('#' + _id + '-olContainer').parent().innerWidth();
            if (parseInt(olMapData[_i].mapOpts.width) > _w) {
                jQuery('#' + _id).width(_w);
                jQuery('#' + _id + '-olStatusBar').width(_w);
                jQuery('#' + _id).parent().parent().find('.olMapHelp').width(_w);
                olMaps[_id].updateSize();
            }
        }

        var resizeTimer;
        jQuery(window).on('resize', function (e) {

            clearTimeout(resizeTimer);
            resizeTimer = setTimeout(function () {
                for (_i = 0; _i < olMapData.length; _i++) {

                    var _id = olMapData[_i].mapOpts.id;
                    var _w = jQuery('#' + _id + '-olContainer').parent().innerWidth();
                    if (parseInt(olMapData[_i].mapOpts.width) > _w) {
                        jQuery('#' + _id).width(_w);
                        jQuery('#' + _id + '-olStatusBar').width(_w);
                        jQuery('#' + _id).parent().parent().find('.olMapHelp').width(_w);
                        olMaps[_id].updateSize();

                    }
                }
            }, 250);
        });

        // hide the table(s) with POI by giving it a print-only style
        jQuery('.olPOItableSpan').addClass('olPrintOnly');
        // hide the static map image(s) by giving it a print only style
        jQuery('.olStaticMap').addClass('olPrintOnly');
        // add help button with toggle.
        jQuery('.olWebOnly > .olMap')
            .prepend(
                '<div class="olMapHelpButtonDiv">'
                + '<button onclick="jQuery(\'.olMapHelp\').toggle(500);" class="olMapHelpButton olHasTooltip"><span>'
                + OpenLayers.i18n("toggle_help") + '</span>?</button></div>');

        // toggle to switch dynamic vs. static map
        jQuery('.olMapHelp').before(
            '<div class="a11y"><button onclick="jQuery(\'.olPrintOnly\').toggle();jQuery(\'.olWebOnly\').toggle();">'
            + OpenLayers.i18n("toggle_dynamic_map") + '</button></div>');
    }
}


/**
 * ol api flag.
 *
 * @type {Boolean}
 */
let olEnable = false;

    /**
     * An array with data for each map in the page.
     *
     * @type {Array}
     */
        const   olMapData = [];

    /**
     * Holds a reference to all of the maps on this page with the map's id as key.
     * Can be used as an extension point.
     *
     * @type {Object}
     */
    let   olMaps = {};

    /**
     * Stamen tiles flag.
     *
     * @type {Boolean}
     */
    let  stamenEnable = false;


    /**
     * Bing tiles flag.
     *
     * @type {Boolean}
     */
    let   bEnable = false;

    /**
     * Bing API key.
     *
     * @type {String}
     */
    let  bApiKey = '';


    /**
     * Thunderforest API key.
     *
     * @type {String}
     */
    let   tfApiKey = ''

    /**
     * OSM tiles flag.
     *
     * @type {Boolean}
     */
    let   osmEnable = true;

    /**
     * CSS support flag.
     *
     * @type {Boolean}
     */
    let   olCSSEnable = true;


/* register olInit to run with onload event. */
jQuery(olInit);


1			/*
2			* Copyright (c) 2022 Mark C. Prins <[email protected]>
3			*
4			* Permission to use, copy, modify, and distribute this software for any
5			* purpose with or without fee is hereby granted, provided that the above
6			* copyright notice and this permission notice appear in all copies.
7			*
8			* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9			* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10			* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11			* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12			* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13			* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14			* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15			*/
16
17
18
19			/**
20			* Test for css support in the browser by sniffing for a css class we added
21			* using javascript added by the action plugin; this is an edge case because
22			* browsers that support javascript generally support css as well.
23			*
24			* @returns {Boolean} true when the browser supports css (and implicitly
25			* javascript)
26			*/
27			function olTestCSSsupport() {
28			return (jQuery('.olCSSsupported').length > 0);
29			}
30
31			/**
32			* Creates a DocumentFragment to insert into the dom.
33			*
34			* @param mapid
35			* id for the map div
36			* @param width
37			* width for the map div
38			* @param height
39			* height for the map div
40			* @returns a {DocumentFragment} element that can be injected into the dom

mprins / dokuwiki-plugin-openlayersmap

Pull Request — master (#10)

script.js ➔ olInit B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like